home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / util / sys / AGPatch_1_2.lha / AGPatch.txt < prev   
Text File  |  1997-07-21  |  4KB  |  125 lines
  1. AGPatch 1.2 by Ben Hutchings
  2. ----------------------------
  3.  
  4.  
  5. Legal: COPYRIGHT 1997 - FREEWARE - NO EXPRESS OR IMPLIED WARRANTY
  6. -----
  7.  
  8.  
  9. Introduction
  10. ------------
  11.  
  12. AmigaGuides were a great idea but it's virtually impossible to create a
  13. decent hypertext document in AmigaGuide form.  There's not much that can
  14. be done about this until some new standard emerges for Amiga hypertext,
  15. but for the time being AGPatch attempts to fix some of the absurd
  16. incompatibilities between different versions of amigaguide.datatype.  It
  17. only works with amigaguide.datatype v40.12, which as far as I know is
  18. the last version publicly released.  This is included in the OS 3.1
  19. upgrade pack and on many magazine cover-CDs; you do not need 3.1 ROMs
  20. to use it.
  21.  
  22.  
  23. The Problems
  24. ------------
  25.  
  26. Problem 1:
  27.  
  28. AmigaGuide up to v39 let you include a literal "@" in a node by putting
  29. "\@" in the source.  Any number of literal backslashes could be included
  30. before the "@" simply by adding an extra backslash; e.g. "\\\@" can be
  31. included by putting "\\\\@" in the source.  AmigaGuide v40 changes this:
  32. backslash escapes any character (including newline), and always exactly
  33. one.  So "\/" becomes "/" whereas it shouldn't change at all, and "\\\@"
  34. becomes "\@" whereas it should become "\\@".  This wrecks many text
  35. diagrams, including those in Commodore's own RKRM guides!
  36.  
  37. It's now impossible to display all guides as the author intended,
  38. because there is no way of telling whether a guide has been designed for
  39. AG v39 or v40.    The best solution I could see was to make backslash only
  40. escape "@" or another backslash, so that is what this patch does.  This
  41. interpretation should allow *virtually* every guide to be displayed as
  42. intended.
  43.  
  44. Problem 2:
  45.  
  46. AmigaGuide before v39 allowed links to be highlighted in various ways,
  47. including the default button-look.  AmigaGuide v39/v40 removed this
  48. option and makes every link look like a button; furthermore, it adds an
  49. extra 2 pixels before and after every link for the button border, so
  50. tables of links don't always line up any more.
  51.  
  52. This patch removes the extra space at the sides of links, and underlines
  53. links rather than drawing buttons (because button frames may overlap
  54. text otherwise).  With this patch installed, link text is normally
  55. rendered in black and underlined; but the currently selected link is
  56. highlighted with a blue background and the link text turns white when
  57. the link is selected with the mouse.  This still doesn't seem quite
  58. right to me, so if you can suggest a better way of rendering links
  59. please do!
  60.  
  61. Problem 3:
  62.  
  63. AmigaGuide v39/v40 has searching and marking disabled, apparently
  64. because these functions are buggy.  I tried re-enabling the marking
  65. function, but it didn't work properly.  Searching doesn't appear to be
  66. supported by the datatypes API, so I don't know how this could be
  67. re-enabled.
  68.  
  69. There might be a solution to this, but I've no idea what it would be.
  70.  
  71.  
  72. Usage
  73. -----
  74.  
  75. AGPatch loads amigaguide.datatype into memory and patches its code.  It
  76. does *not* modify the original file.
  77.  
  78. AGPatch can only be run from the CLI.  The command format is
  79.  
  80.     AGPatch [NOESCAPEPATCH] [LINKPATCH]
  81.  
  82. The default behaviour is to patch only the backslash escape code
  83. (Problem 1).  Using the NOESCAPEPATCH switch disables this patch; using
  84. the LINKPATCH enables the patch for link display (Problem 2).
  85.  
  86. AGPatch cannot be removed once it has been installed.  This is partly
  87. because it's rather tricky to do so, but also because I'm too lazy to do
  88. it properly. ;-)
  89.  
  90. To see the effect of the patch, run it now and view some AmigaGuides.
  91. If you're happy with it, copy AGPatch onto your hard disk and add it
  92. into your s:user-startup script.
  93.  
  94.  
  95. History
  96. -------
  97.  
  98. version 1.0 (4.11.97)
  99.  
  100.     First public release.
  101.  
  102. version 1.1 (17.7.97)
  103.  
  104.     Added options to enable or disable the two patches, and improved
  105.     documentation.
  106.  
  107. version 1.2 (21.7.97)
  108.  
  109.     Fixed a bug that crept into version 1.1, which caused programs
  110.     later in user-startup or startup-sequence to become unstable.
  111.  
  112.  
  113. Contact addresses
  114. -----------------
  115.  
  116. Ben Hutchings
  117. 43 Harrison Close
  118. Reigate
  119. Surrey RH2 7HS
  120. ENGLAND
  121.  
  122. email: benjamin.hutchings@worcester.oxford.ac.uk
  123. WWW: http://users.ox.ac.uk/~worc0223/amiga/freeware/
  124. IRC: womble or wombleII, usually on Undernet #amigacafe
  125.